Improve change note checking #14542
Merged
Improve change note checking #14542
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aeisenberg
reviewed
Oct 19, 2023
|
|
||
| echo "Change notes found:" | ||
| echo "$change_note_files" | ||
|
|
||
| - name: Fail if the change note filename doesn't match the expected format. The file name must be of the form 'YYYY-MM-DD.md', 'YYYY-MM-DD-{title}.md', where '{title}' is arbitrary text, or released/x.y.z.md for released change-notes |
There was a problem hiding this comment.
This long name for the step doesn't really make sense. Maybe shorten it to a handful of words and print out some variant of the deleted text if there is an error.
There was a problem hiding this comment.
I agree that is an atypically long workflow step name, but I think the motivation is that the long name acts as a description at some convenient UI level.
Example.
A general rewrite with the more modern markdown step summaries could be worthwhile in general.
aeisenberg
approved these changes
Oct 19, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses feedback in internal issue.
The change note file name checks are now more verbose explaining why they behave as they do.